BeforeInstallPromptEvent: userChoice property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The userChoice property of the BeforeInstallPromptEvent interface represents the installation choice that the user made, when they were prompted to install the app.

Value

A Promise which resolves to an object containing two properties:

outcome

A string indicating whether the user chose to install the app or not. It must be one of the following values:

  • "accepted": The user installed the app.
  • "dismissed": The user did not install the app.
platform

If the user chose to install the app, this is a string naming the selected platform, which is one of the values from the BeforeInstallPromptEvent.platforms property. If the user chose not to install the app, this is an empty string.

Browser compatibility

See also